feat(api): add launchOptions support to ConnectOptions #1858
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add ability to pass LaunchOptions directly via ConnectOptions instead of manually constructing JSON headers. This provides a type-safe and convenient way to specify launch options like browser channel when connecting to a remote browser. The implementation automatically serializes launchOptions to the x-playwright-launch-options header when provided.
Author
|
@microsoft-github-policy-service agree |
yury-s
requested changes
Nov 12, 2025
Member
There was a problem hiding this comment.
This file is generated from https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browsertype.md, please don't edit it manually. I also suggest you start with filing a new issue in https://github.com/microsoft/playwright with a description of the problem.
x-playwright-launch-options is currently a private property. If we want to expose it in the API it should be available in other ports too, in Node.js in the first place. Let's assess the use case first.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add ability to pass LaunchOptions directly via ConnectOptions instead of manually constructing JSON headers.
The implementation automatically serializes launchOptions to the x-playwright-launch-options header when provided.
Motivation / Use case
When running the browser inside a container and connecting remotely (see Playwright docs: Remote connection with Docker), it’s currently cumbersome to specify the browser channel.
current:
connectOptions.headers.put("x-playwright-launch-options", "{\"channel\":\"msedge\"}");which you have to discover first
Proposed API (Java)